Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(v2): i18n doc + polish #4014

Merged
merged 25 commits into from
Jan 19, 2021
Merged

docs(v2): i18n doc + polish #4014

merged 25 commits into from
Jan 19, 2021

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Jan 7, 2021 •
edited
Loading

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 7, 2021
@github-actions
Copy link

github-actions bot commented Jan 7, 2021 •
edited
Loading

Size Change: 0 B

Total Size: 26.8 kB

ℹ️ View Unchanged
Filename Size Change
website/build/blog/2017/12/14/introducing-docusaurus/index.html 20.8 kB 0 B
website/build/docs/introduction/index.html 180 B 0 B
website/build/index.html 5.86 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Jan 7, 2021 •
edited
Loading

✔️ Deploy preview for docusaurus-2 ready!

🔨 Explore the source changes: 92c037c

🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-2/deploys/6001d2b2505d9600076ac37b

😎 Browse the preview: https://deploy-preview-4014--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Jan 7, 2021 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 68
🟢 Accessibility 99
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4014--docusaurus-2.netlify.app/classic/

@slorber slorber mentioned this pull request Jan 8, 2021
Merged
@clairefro
Copy link

clairefro commented Jan 9, 2021 •
edited
Loading

Excellent write-up and tutorial, thank you! 🙏

Some suggestions:

  1. In Introduction or Tutotrial, it would be very helpful to include an example project filetree structure for a basic FR/EN site à la this. Doc location is crucial in this framework.

  2. In Use Crowdin or FAQ, regarding CI it may be helpful to share that Crowdin has integrations with Github and other version management sites. EDIT: Here are the docs on how to setup, https://support.crowdin.com/github-integration/

  • To make it so only translated and approved content is PRed on sync, make sure that in Crowdin > Project > Settings > General the Export settings have checked Skip untranslated files and Export only approved translations
    image

@clairefro
Copy link

P.S. - are there any SEO considerations to be aware of?

@slorber
Copy link
Collaborator Author

slorber commented Jan 12, 2021

Thanks.

Will include a project tree example

For now I just put a simple note about the github integration here: https://deploy-preview-4014--docusaurus-2.netlify.app/classic/docs/next/i18n/crowdin#automate-with-ci

Unfortunately, and after talking with Crowdin support, it does not work if the crowdin.yml is not at the root of the repo (ie website/crowdin.yml does not work, as I use this in the tutorial). Don't really understand why but unfortunately that's the current state 😅 I may need to adapt the tutorial

About SEO, I don't think there's much to be said apart from that I'll add support for hreflang meta headers + an option to disable the headers. Let me know if you think about something else that could be useful.

@netlify
Copy link

netlify bot commented Jan 12, 2021 •
edited
Loading

✔️ [V1] Deploy preview success

🔨 Explore the source changes: 92c037c

🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-1/deploys/6001d2b256cd06000875b509

😎 Browse the preview: https://deploy-preview-4014--docusaurus-1.netlify.app

@clairefro
Copy link

Unfortunately, and after talking with Crowdin support, it does not work if the crowdin.yml is not at the root of the repo

strange! if you'd like a working example, we have github crowdin integration working fine in this repo:
https://github.com/redwoodjs/learn.redwoodjs.com

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Jan 14, 2021
@slorber slorber marked this pull request as ready for review January 15, 2021 16:46
@slorber slorber requested a review from lex111 as a code owner January 15, 2021 16:46
@slorber slorber merged commit a8ee7fd into master Jan 19, 2021
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
slorber added a commit that referenced this pull request Jul 22, 2021
@slorber
docs(v2): i18n doc + polish (#4014)
61cd834 
* add some initial i18n doc

* i18n doc progress

* i18n tutorial progress

* i18n tutorial progress

* polish Crowdin docs

* i18n sidebar in guides

* polish crowdin doc

* update Crowdin doc a bit

* fix annoying relative link to global site resource in template (breaks i18n tutorial)

* template: use simpler export for homepage

* add markdown page example

* rename mdx.md to interactiveDoc.mdx

* update bootstrap/facebook templates too

* sync init template package scripts

* add slug frontmatter doc

* improve i18n doc

* complete i18n doc

* temporarily enable the localeDropdown

* doc typo

* improve the i18n doc

* Add Git i18n doc

* add missing "--" for npm run options (unfortunately they don't get stripped by npm2yarn, and are required foor npm)

* improve a bit the Crowdin doc
@slorber slorber deleted the slorber/i18n-doc branch August 17, 2021 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lex111 lex111 Awaiting requested review from lex111

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Milestone
v2.0.0-alpha.71
Development

Successfully merging this pull request may close these issues.
4 participants
@slorber @clairefro @lex111 @facebook-github-bot